<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Structures  Reference</title>
    <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="css/highlight.css" />
    <meta charset='utf-8'>
    <script src="js/jquery.min.js" defer></script>
    <script src="js/jazzy.js" defer></script>
    
  </head>
  <body>
    <a name="//apple_ref/swift/Section/Structures" class="dashAnchor"></a>
    <a title="Structures  Reference"></a>
    <header>
      <div class="content-wrapper">
        <p><a href="index.html">UICircularProgressRing 7.0.0 Docs</a> (100% documented)</p>
      </div>
    </header>
    <div class="content-wrapper">
      <p id="breadcrumbs">
        <a href="index.html">UICircularProgressRing Reference</a>
        <img id="carat" src="img/carat.png" />
        Structures  Reference
      </p>
    </div>
    <div class="content-wrapper">
      <nav class="sidebar">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a href="Enums.html">Enumerations</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Enums/RingAxis.html">RingAxis</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/RingColor.html">RingColor</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/RingProgress.html">RingProgress</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/TimerRingTimeUnit.html">TimerRingTimeUnit</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Structs.html">Structures</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Structs/IndeterminateRing.html">IndeterminateRing</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/PercentFormattedText.html">PercentFormattedText</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/ProgressRing.html">ProgressRing</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/Ring.html">Ring</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/RingStyle.html">RingStyle</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/TimerRing.html">TimerRing</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">
        <section>
          <section class="section">
            <h1>Structures</h1>
            <p>The following structures are available globally.</p>

          </section>
          <section class="section task-group-section">
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:22UICircularProgressRing0C0V"></a>
                    <a name="//apple_ref/swift/Struct/Ring" class="dashAnchor"></a>
                    <a class="token" href="#/s:22UICircularProgressRing0C0V">Ring</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <h1 id='ring' class='heading'>Ring</h1>

<p>A view which represents a ring (a circle with a stroke).
The <code>percent</code> determines how much of the ring is drawn starting from the <code>axis</code>.</p>

<p>Example: A ring with an axis of <code><a href="Enums/RingAxis.html#/s:22UICircularProgressRing0C4AxisO3topyA2CmF">RingAxis.top</a></code>, a percent of <code>0.5</code>, and <code>clockwise == true</code> will draw
a stroked circle from <code>90</code> degrees (on a unit circle) to <code>270</code> degrees.</p>

                        <a href="Structs/Ring.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Ring</span><span class="o">&lt;</span><span class="kt">Content</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">Content</span> <span class="p">:</span> <span class="kt">View</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Ring</span><span class="p">:</span> <span class="kt">View</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:22UICircularProgressRing0C5StyleV"></a>
                    <a name="//apple_ref/swift/Struct/RingStyle" class="dashAnchor"></a>
                    <a class="token" href="#/s:22UICircularProgressRing0C5StyleV">RingStyle</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <h1 id='ringstyle' class='heading'>RingStyle</h1>

<p>A custom specification for the appearance and interaction of a <code><a href="Structs/Ring.html">Ring</a></code>.</p>

                        <a href="Structs/RingStyle.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">RingStyle</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:22UICircularProgressRing013IndeterminateC0V"></a>
                    <a name="//apple_ref/swift/Struct/IndeterminateRing" class="dashAnchor"></a>
                    <a class="token" href="#/s:22UICircularProgressRing013IndeterminateC0V">IndeterminateRing</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>An <code>IndeterminateRing</code> is a <code>View</code> which displays
an animated ring to represent some long running task.</p>

                        <a href="Structs/IndeterminateRing.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">IndeterminateRing</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">IndeterminateRing</span><span class="p">:</span> <span class="kt">View</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:22UICircularProgressRing20PercentFormattedTextV"></a>
                    <a name="//apple_ref/swift/Struct/PercentFormattedText" class="dashAnchor"></a>
                    <a class="token" href="#/s:22UICircularProgressRing20PercentFormattedTextV">PercentFormattedText</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>A view which displays the current percentage using a number formatter.</p>

                        <a href="Structs/PercentFormattedText.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">PercentFormattedText</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">PercentFormattedText</span><span class="p">:</span> <span class="kt">View</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:22UICircularProgressRing0bC0V"></a>
                    <a name="//apple_ref/swift/Struct/ProgressRing" class="dashAnchor"></a>
                    <a class="token" href="#/s:22UICircularProgressRing0bC0V">ProgressRing</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <h1 id='progressring' class='heading'>ProgressRing</h1>

                        <a href="Structs/ProgressRing.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ProgressRing</span><span class="o">&lt;</span><span class="kt">Label</span><span class="p">,</span> <span class="kt">IndeterminateView</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">Label</span> <span class="p">:</span> <span class="kt">View</span><span class="p">,</span> <span class="kt">IndeterminateView</span> <span class="p">:</span> <span class="kt">View</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">ProgressRing</span><span class="p">:</span> <span class="kt">View</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:22UICircularProgressRing05TimerC0V"></a>
                    <a name="//apple_ref/swift/Struct/TimerRing" class="dashAnchor"></a>
                    <a class="token" href="#/s:22UICircularProgressRing05TimerC0V">TimerRing</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <h1 id='timerring' class='heading'>TimerRing</h1>

<p>A specialized <code><a href="Structs/Ring.html">Ring</a></code> for displaying time.</p>

                        <a href="Structs/TimerRing.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">TimerRing</span><span class="o">&lt;</span><span class="kt">Label</span><span class="o">&gt;</span> <span class="k">where</span> <span class="kt">Label</span> <span class="p">:</span> <span class="kt">View</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">TimerRing</span><span class="p">:</span> <span class="kt">View</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </section>
        </section>
        <section id="footer">
          <p>&copy; 2020 <a class="link" href="http://ucpr.luispadron.com" target="_blank" rel="external">Luis Padron</a>. All rights reserved. (Last updated: 2020-07-12)</p>
          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
        </section>
      </article>
    </div>
  </body>
</div>
</html>
